home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Diamond Collection / The Diamond Collection (Software Vault)(Digital Impact).ISO / cdr37 / fwklz202.zip / LOOKUP.DOC < prev    next >
Text File  |  1995-03-31  |  25KB  |  584 lines
  1. LOOKUP(TM), LOOKUPZ(TM), and RCROSREF(TM) are part of
  2. FWKCS(TM) Contents_Signature System, Ver. 2.02, 1995 Mar 31.
  3. (C)Copyright Frederick W. Kantor 1989, 1995. All rights reserved.
  4. Your use of any of these programs is at solely your own risk:
  5. ........................ C A V E A T   O P E R A T O R ........................
  6.  
  7.  
  8.  
  9.  
  10.                     L O O K U P
  11.                     ~~~~~~~~~~~
  12.                                     with
  13.  
  14.                                              R c r o s r e f
  15.                                              ~~~~~~~~~~~~~~~
  16.  
  17.  
  18.                and  L O O K U P Z  <---<< this one does not use a
  19.                     ~~~~~~~~~~~~~         registration key.
  20.  
  21.  
  22.  
  23.                               For on_line help,
  24.  
  25.                                   type     LOOKUP <enter>
  26.  
  27.                                            LOOKUPZ <enter>
  28.  
  29.                                            RCROSREF <enter>
  30.  
  31.                               Each of those commands will put
  32.                               instructions onto the screen, with an
  33.                               example you can use while you make your
  34.                               entry.
  35.  
  36.  
  37.             The FWKCS(TM) Contents_Signature System, Versions 1.10 and
  38.         later, provides a special way for an electronic bulletin board
  39.         system ("BBS") to help you. "Lookup" provides you with a quick,
  40.         easy way to find out if that BBS has any file which matches a
  41.         particular file you have. This matching is tested quickly,
  42.         using contents_signatures which have much greater resolution
  43.         than is provided by the older 32_bit CRCs.
  44.  
  45.             FWKCS Version 2.02's LOOKUPZ makes this support available
  46.         to persons who have only the LOOKUPZ.BAT program and PKWARE's
  47.         PKZIP.EXE -- plus, of course, a way to call a BBS which is
  48.         running FWKCS 2.00 or later.
  49.  
  50.             You can then use Rcrosref to follow up on contents_
  51.         signature cross_references which a BBS may provide in replying
  52.         to your Lookup inquiry.
  53.  
  54.             For a plain file, this ability to find matching file(s)
  55.         does not depend on the name or date of the file (to use
  56.         LOOKUPZ, put the plain file in a zipfile first).
  57.  
  58.             For a zipfile, this ability to find matching file(s) does
  59.         not depend on the name or date of the zipfile, the amount of
  60.         compression of different files in it, the names or dates of the
  61.         files in it, zipped path information, file comments, the
  62.         zipfile comment, nor on the order in which the files appear in
  63.         the zipfile.
  64.  
  65.             Before you upload a file or a zipfile to the BBS, you can
  66.         upload an "inquiry file" which Lookup or Lookupz makes for you.
  67.         The BBS then quickly tells you if it already has any of that
  68.         material, and, if so, in what file or zipfiles you can find
  69.         that material, and by what name it is called in each of those
  70.         places (which can be a different name in each place). You don't
  71.         have to waste your time or run up your telephone bill uploading
  72.         a file they already have.
  73.  
  74.             Before you lose sleep looking for the missing instructions
  75.         for a computer game that also got renamed along the way, you
  76.         can use Lookup of Lookupz to look for the whole package on a
  77.         big BBS in seconds.
  78.  
  79.             "Lookup(z)" and FWKCS work together to turn big BBSs into
  80.         multi_gigabyte high_speed reference libraries which you can
  81.         reach from the comfort of your home or office, or from a
  82.         portable computer -- even if you don't know the name of what
  83.         you are looking up.
  84.  
  85.  
  86.         How to use Lookup
  87.         ~~~~~~~~~~~~~~~~~
  88.  
  89.         You just type
  90.  
  91.              LOOKUP FILENAME.EXE T1045.ZIP <enter>     (for detailed reply)
  92.         or
  93.              LOOKUP FILENAME.EXE T1045.ZIP ! <enter>      (for short reply)
  94.  
  95.         where
  96.                 FILENAME.EXE  is the full filename and extension of
  97.                               the file you want to look up
  98.  
  99.                 T1045.ZIP     is any name you want to make up,
  100.                               using the extension .ZIP
  101.  
  102.                               (if the file you want to look up is
  103.                               located in the default directory with
  104.                               the output file, then the output file
  105.                               must have a different name than the
  106.                               input file. For a way around this,
  107.                               see Example 4, below.)
  108.  
  109.                           !   is literal, to request a reply
  110.                               without details
  111.  
  112.             "Lookup" prepares a special output file, with the name you
  113.         choose.  You then call the BBSs, and upload the special file
  114.         that Lookup made.
  115.  
  116.         How to use Lookupz
  117.         ~~~~~~~~~~~~~~~~~~
  118.             To use Lookupz, the BBS you are calling must be running
  119.         FWKCS 2.00 or later.
  120.  
  121.             It's a lot like using Lookup:
  122.  
  123.         You just type
  124.  
  125.              LOOKUPZ FILES.ZIP T1045.ZIP <enter>     (for detailed reply)
  126.         or
  127.              LOOKUPZ FILES.ZIP T1045.ZIP ! <enter>      (for short reply)
  128.  
  129.         where
  130.                 FILES.ZIP  contains up to 512 files to look up at one
  131.                            time
  132.  
  133.                 T1045.ZIP  is any name you want to make up,
  134.                            using the extension .ZIP
  135.  
  136.                         !  is literal, to request a reply
  137.                            without details
  138.  
  139.             If you are just interested in a short estimate as to
  140.         whether a file or zipfile would be sufficiently new to be
  141.         worth uploading, you can use the second format, which has the
  142.         exclamation point "!" in it. If you are communicating with a
  143.         BBS which is using FWKCS Ver. 1.15 or later, the reply omits
  144.         the detailed list of matching files. (That request for a short
  145.         reply is not accepted by earlier versions of FWKCS, and would
  146.         be rejected as defective.)
  147.  
  148.             If you are using the top format (without the "!"), capture
  149.         the BBS's reply to a file, for use later.  For discussion
  150.         below, we will assume that the captured reply is in a file
  151.         called BBS.CAP.
  152.  
  153.             The BBS will tell you that the upload "failed" -- that
  154.         means that you don't get any upload credit for having sent it
  155.         -- but it will send you a special message prepared there by
  156.         FWKCS, telling you whether it found any matching contents_
  157.         signature(s), and, if so, in what file(s). Normally, the name
  158.         of the inquiry file you uploaded is available for use again.
  159.  
  160.             It will display your input item, and below that either a
  161.         line which says "did not find cs_match", or two or more lines
  162.         which say something like, for example,
  163.  
  164.         found:
  165.          FILENAME.EXT ZIPFILNM.ZIP D:
  166.         |            |            |
  167.         1      2     3     4      5 6
  168.  
  169.         At these locations 1...6, you may see:
  170.  
  171.         1. lower_case letters used as flags:
  172.  
  173.            r  cross_reference; in this case, the format for the rest of
  174.               the line is different, because it is used for carrying a
  175.               contents_signature to which cross_reference is made.
  176.               (see FWKCS202.REF, Auxiliary Function 3, option r)
  177.  
  178.               this flag is used in Rcrosref, discussed below;
  179.  
  180.            w  wipe (remove if found in non_AV zipfiles): for example,
  181.               a known ad;
  182.  
  183.            x  exclude (reject file or zipfile): for example, known
  184.               commercial software (don't upload a file for which you
  185.               receive such an x flag, because it will be rejected);
  186.  
  187.            others are listed in FWKCS202.REF under Special Column_17
  188.            Flags.
  189.  
  190.         2. the name of a file in a zipfile, in which case the zipfile
  191.            name is in location 4; or
  192.  
  193.            the name of a zipfile, in which case "z   cs" appears in
  194.            location 4; or
  195.  
  196.            the name of a non_zip file, in which case "f cs" appears in
  197.            location 4.
  198.  
  199.         3. lower_case letters used to indicate Authenticity
  200.            Verification and/or encryption:
  201.  
  202.            a  the file in 2 has authenticity verification in a zipfile,
  203.               in which case the zipfile name appears in 4 and has a
  204.               lower_case v in location 5
  205.  
  206.            p  the file in 2 is an apparently encrypted ("private") file
  207.               in a zipfile
  208.  
  209.            u  the file in 2 has authenticity verification and
  210.               apparently encrypted material;
  211.  
  212.                  if the name of a zipfile appears in location 4, then
  213.                  the file in location 2 is contained in that zipfile
  214.  
  215.                  if "z   cs" appears in location 4, then the file in
  216.                  location 2 is a zipfile which contains at least one
  217.                  file which has authenticity verification and at least
  218.                  one file which is apparently encrypted (possibly
  219.                  different files)
  220.  
  221.            v  the file in location 2 is a zipfile which contains at
  222.               least one file which has authenticity verification, and
  223.               does not contain any apparently encrypted file.
  224.  
  225.         4. the name of a zipfile which contains the file named in
  226.            location 2; or
  227.  
  228.              "f cs" indicating that the file in location 2 is not a
  229.                     zipfile
  230.  
  231.            "z   cs" indicating that the file in location 2 is a zipfile
  232.  
  233.         5. may contain a lower_case "v", in which case the file in
  234.            location 4 is a zipfile which contains at least one file
  235.            which has authenticity verification.
  236.  
  237.         6. may contain a drive_letter and colon, e.g., D:, indicating
  238.            that the matching contents_signature which was found belongs
  239.            to a file which may be currently available on the BBS
  240.  
  241.            if there is no drive letter with colon, that often means
  242.            that the contents_signature which was found came from a file
  243.            which is not available on the BBS, such as a file which has
  244.            been retired from the system; but if the BBS accepts
  245.            zipfiles which contain other zipfiles, and a zipfile is
  246.            named in location 4 (above), then the absence of drive
  247.            letter with colon might mean that the contents_signature
  248.            came from a file which is contained in a zipfile which is,
  249.            itself, contained in the zipfile named in location 4:  for
  250.            this reason, it is suggested that you test for the existence
  251.            of the zipfile named in location 4 (e.g., by a filename
  252.            search on the BBS).
  253.  
  254.         (For use of "a" and "v", see Example 3, below).
  255.  
  256.             Also, it may tell you (in words) if any of the matching
  257.         material you asked about was marked for automatic total
  258.         exclusion on that BBS (for example, commercial software might
  259.         be marked for automatic exclusion).  Whether or not you are
  260.         told in words, any such exclusion is shown in a full listing by
  261.         a lower_case "x" in the left column next to each such item
  262.         found.
  263.  
  264.             There may be a special marker to tell you if one or more
  265.         parts of the material you asked about was marked for Wiping
  266.         (automatic removal from uploaded non_AV zipfiles). These are
  267.         marked with a lower_case "w" in the left column next to the
  268.         item found.  For example, known spurious advertisements may be
  269.         marked for automatic removal.
  270.  
  271.             Depending on options set up on the particular BBS you call,
  272.         it may tell you whether there would be a question as to
  273.         sufficient novelty were you to upload the material you asked
  274.         about. Different BBSs have different settings for this. Of
  275.         course, if you are interested in downloading rather than
  276.         uploading, such a comment does not apply to you, but the BBS
  277.         doesn't know the reason for your call.
  278.  
  279.             Other information is also provided.
  280.  
  281.         Example 1
  282.         ~~~~~~~~~
  283.             Suppose you want to find out if a single, plain (non_zip)
  284.         file is contained in one of the zipfiles on a big BBS.
  285.  
  286.            Type   LOOKUP file t43012.zip <enter>
  287.  
  288.            Upload  T43012.ZIP  to the BBS.
  289.  
  290.            Capture the screen to a file for use later, and read the
  291.         message as it comes in.
  292.  
  293.            Here is one example of a message back, where it did not find
  294.         any matching contents_signature:
  295.  
  296.  
  297.             --- contents_signature(s) from the file  T43012.ZIP  which
  298.             you just uploaded were compared with those of prior file(s).
  299.  
  300.             - re your request for a contents_signature search:
  301.  
  302.             - did not find any contents_signature match.
  303.  
  304.             --- the file  T43012.ZIP  has been deleted.
  305.  
  306.  
  307.             The message you actually receive may be more "personalized",
  308.         addressing you by your first name.
  309.  
  310.             Please be aware that, although the above message says that
  311.         the file has been deleted, certain bulletin board software does
  312.         not operate correctly if the filename is also deleted; for
  313.         example, Mustang Software's Wildcat requires that the filename
  314.         remain, so a substitute file is used to replace the deleted
  315.         file. However, because the file was treated as rejected, the
  316.         further availability of that name for re_use follows the same
  317.         treatment as for other rejected files.
  318.  
  319.             Clark Development Co.'s PCBoard does not require that the
  320.         filename remain, and you are free to use that filename again.
  321.  
  322.  
  323.         Example 2
  324.         ~~~~~~~~~~
  325.         Suppose you do this:
  326.  
  327.             LOOKUP FOO T43005.ZIP <enter>
  328.  
  329.             Upload  T43005.ZIP  to the BBS
  330.  
  331.         and receive:
  332.  
  333.  
  334.       --- contents_signature(s) from the file  T43005.ZIP  which
  335.       you just uploaded were compared with those of prior file(s).
  336.  
  337.       - re your request for a contents_signature search:
  338.  
  339.       - a contents_signature match was found for each input file;
  340.       the input file(s) might be not ZIPped.
  341.  
  342.       ==============================================================
  343.       > Referring to C:\CS\CSLIST.SRT ------------------------------
  344.       ==============================================================
  345.       6416DCA5     2AB FOO             f cs      C:\CS\CSK\3\1
  346.       did not find cs_match
  347.       ==============================================================
  348.       > Referring to C:\CS\CSLIST1.SRT -----------------------------
  349.       ==============================================================
  350.       6416DCA5     2AB FOO             f cs      C:\CS\CSK\3\1
  351.       found:
  352.        FOOF            f cs      C:
  353.       ==============================================================
  354.  
  355.       --- the file  T43005.ZIP  has been deleted.
  356.  
  357.  
  358.             The "f cs" means that the "file contents_signature" was for
  359.         a plain file.
  360.  
  361.             The "C:" to the right of the item found means that the
  362.         contents_signature entry is not carried forward from a file
  363.         which has been retired from the BBS. If the file has been
  364.         retired, its contents_signature is normally carried forward
  365.         without a drive letter and without the ":". The contents_
  366.         signature continues to serve in preventing old material from
  367.         accidentally being accepted as if it were new, and the space
  368.         left by removing the retired file is available for current
  369.         material. (For instance, this may happen when an author issues
  370.         a revised version of one of his/her programs.)
  371.  
  372.  
  373.         Example 3
  374.         ~~~~~~~~~
  375.         Suppose you do this:
  376.  
  377.             LOOKUP FWKDG108.SNT M.M <enter>
  378.  
  379.             "Upload"  M.M  to your own local system
  380.  
  381.         and receive:
  382.  
  383.  
  384.      --- contents_signature(s) from the file  M.M  which
  385.      you just uploaded were compared with those of prior file(s).
  386.  
  387.      - re your request for a contents_signature search:
  388.  
  389.      - a contents_signature match was found for every contained file, but
  390.      not for zipfile_contents_signature; the contents may have appeared in
  391.      a larger prior ZIP, or been spread among more than one prior ZIPfiles.
  392.  
  393.      ==============================================================
  394.      > Referring to C:\CS\CSLIST.SRT ------------------------------
  395.      ==============================================================
  396.      168CA0F0    295B FWKDG108.SNT  z   cs      C:\ZIPS
  397.      did not find cs_match
  398.      **
  399.      299209E9     B59 FWKDG.COM    FWKDG108.SNT C:\ZIPS
  400.      found:
  401.       FWKDG.COM    FWKDG1A8.ZIP C:
  402.       FWKDG.COM   aFWKCS104.ZIPvC:
  403.      **
  404.      5FB1021A      49 FWKDG108.BAT FWKDG108.SNT C:\ZIPS
  405.      found:
  406.       FWKDG108.BAT FWKDG1A8.ZIP C:
  407.       FWKDG108.BATaFWKCS104.ZIPvC:
  408.      **
  409.      B8783FE7    1ADB FWKDG108.DOC FWKDG108.SNT C:\ZIPS
  410.      found:
  411.       FWKDG108.DOC FWKDG1A8.ZIP C:
  412.      **
  413.      D4D15506     2DE FWKDG108.SCR FWKDG108.SNT C:\ZIPS
  414.      found:
  415.       FWKDG108.SCR FWKDG1A8.ZIP C:
  416.       FWKDG108.SCRaFWKCS104.ZIPvC:
  417.      ==============================================================
  418.      > Referring to C:\CS\CSLIST1.SRT -----------------------------
  419.      ==============================================================
  420.      168CA0F0    295B FWKDG108.SNT  z   cs      C:\ZIPS
  421.      did not find cs_match
  422.      **
  423.      299209E9     B59 FWKDG.COM    FWKDG108.SNT C:\ZIPS
  424.      did not find cs_match
  425.      **
  426.      5FB1021A      49 FWKDG108.BAT FWKDG108.SNT C:\ZIPS
  427.      did not find cs_match
  428.      **
  429.      B8783FE7    1ADB FWKDG108.DOC FWKDG108.SNT C:\ZIPS
  430.      did not find cs_match
  431.      **
  432.      D4D15506     2DE FWKDG108.SCR FWKDG108.SNT C:\ZIPS
  433.      did not find cs_match
  434.      ==============================================================
  435.  
  436.      --- the file  M.M  has been deleted.
  437.  
  438.  
  439.         The items which appear in two columns directly below the word
  440.         "found:" are
  441.  
  442.           if there is a filename in the right column, then it is the
  443.           name of the zipfile which contains the file listed next to it
  444.           in the left column -- the cs_match (contents_signature match)
  445.           was made to the file in the left column.
  446.  
  447.           if there is no filename in the right column, you typically
  448.           will see either
  449.  
  450.               "f cs"   indicating a plain_file contents_signature
  451.  
  452.           or
  453.  
  454.             "z   cs"  indicating a zipfile_contents_signature, in
  455.                       which all the files in a zipfile are taken
  456.                       together in a special way.  (For technical
  457.                       discussion of this, see FWKCS202.REF.)
  458.  
  459.           In these cases, too, the cs_match is made to the file in the
  460.           left column.
  461.  
  462.  
  463.         Example 4
  464.         ~~~~~~~~~
  465.             Depending on the kind of bulletin board software used by
  466.         the BBS you are calling, you may be able to save connect_time
  467.         in testing whether a file or zipfile would be acceptable as an
  468.         upload to a BBS, by using Lookup to ask if the contents are
  469.         already known to the BBS, and using the same filename as the
  470.         one you want to upload later.  Because the inquiry file is
  471.         treated as "rejected", various bulletin board systems treat the
  472.         name which was used for it as being available for another
  473.         upload.
  474.  
  475.             If you can use this method on the BBS you're calling, here
  476.         is how to do it:
  477.  
  478.             Start with the file you want to inquire about in a
  479.         different directory than you are working in. For example,
  480.  
  481.  
  482.             default           <-- where you are now
  483.                |
  484.              sub1\FOO.ZIP     <-- the file you want to get
  485.                                   information about
  486.  
  487.         Type  LOOKUP sub1\foo.zip foo.zip ! <enter>
  488.  
  489.                                 (the "!" is to request a short reply)
  490.  
  491.         Then upload this new FOO.ZIP which was created in the default
  492.         directory, to find out whether you should upload the original
  493.         FOO.ZIP.
  494.  
  495.  
  496.         Example 5
  497.         ~~~~~~~~~
  498.         If the BBS you are calling is using FWKCS Version 1.20 or
  499.         later, and you wish to make an inquiry as to whether several
  500.         non_zip files are recognized on a BBS, you can ask re up to 512
  501.         such files in one inquiry, using wildcards.  For example, if
  502.         you put all, and only, those files into your sub1 directory
  503.         (see example 4, above), you can then type
  504.  
  505.             LOOKUP sub1\*.* T43005.ZIP <enter>
  506.  
  507.         and then send T43005.ZIP (or whatever name you use) as your
  508.         inquiry.
  509.  
  510.            Notes: do not ask re both a zipfile and a non_zip file in
  511.                   the same remote inquiry;
  512.  
  513.                   do not ask re multiple zipfiles in the same remote
  514.                   inquiry.
  515.  
  516.  
  517.         How to use Rcrosref
  518.         ~~~~~~~~~~~~~~~~~~~
  519.  
  520.             You just type
  521.  
  522.                   RCROSREF BBS.CAP T1045.ZIP <enter>
  523.  
  524.             where
  525.                     BBS.CAP    is the full filename and extension of
  526.                                the file you used to capture the BBS's
  527.                                reply to your Lookup
  528.  
  529.                     T1045.ZIP  is any name you want to make up, using
  530.                                the extension .ZIP
  531.  
  532.  
  533.         If Rcrosref does not find any contents_signature cross_
  534.         reference in the BBS.CAP reply file, it will tell you so, and
  535.         will not make the new inquiry zipfile.
  536.  
  537.         If Rcrosref makes a new inquiry zipfile, just upload it to the
  538.         same BBS, and capture the reply in a new BBS.CAP, etc.
  539.  
  540.           Note: One way of organizing a cross_reference system is to
  541.                 use "nodes" to which many related files are linked. In
  542.                 that case, the first reply to a Lookup inquiry may
  543.                 include a small number of references to one or more
  544.                 such nodes. The first Rcrosref inquiry based on that
  545.                 reply may bring back a large number of cross_references
  546.                 from those nodes which were cited. The second Rcrosref
  547.                 inquiry may then bring back the names of the files
  548.                 (and, if they are contained in zipfiles, the names of
  549.                 zipfiles in which they can be found) for downloading.
  550.                 (The maximum number of input items for a single remote
  551.                 contents_signature search is 512. See Auxiliary
  552.                 Function 5, option i, in FWKCS202.REF.)
  553.  
  554.     -----------------------------------------------------------------------
  555.  
  556.         Technical:
  557.         ~~~~~~~~~~
  558.         To support remote inquiry operations, the BBS must be running
  559.         FWKCS Version 1.10 or later, with option i (remote Inquiry)
  560.         active when processing uploads. To support the terse reply ("!")
  561.         option, the BBS must be running FWKCS Version 1.15 or later.
  562.         To support remote inquiries prepared using Lookupz, the BBS
  563.         must be running FWKCS Version 2.00 or later.
  564.  
  565.         The flags in the left column are the special Column_17 flags,
  566.         described in FWKCS202.REF.
  567.  
  568.         The contents_signature format, and the meaning of the fcs and
  569.         zcs notation, are explained in FWKCS202.REF; the cross_
  570.         reference structure is explained there under Auxiliary Function
  571.         3, option r.
  572.  
  573.         The statistical resolution is discussed in FWKCS202.REF, with
  574.         diagrams.  On a large BBS, this typically has a statistical
  575.         resolution more than one thousand times as good as the best
  576.         that would be provided solely by a 32_bit CRC.  It removes
  577.         the CRC effect of accidentally mistaking for each other files
  578.         which have different lengths. A new contents_signature was
  579.         introduced because the 32_bit CRC does not represent enough
  580.         information to meet the needs of large electronic bulletin
  581.         board systems, for reasons which are explained in FWKCS202.REF.
  582.         "Lookup", "Lookupz", and "Rcrosref" pass these benefits on to
  583.         you.
  584.